Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive API documentation to the OpenCloud developer docs, introducing detailed documentation for HTTP-based APIs including WebDAV, LibreGraph, and TUS upload protocols. The documentation provides practical examples, endpoint descriptions, and implementation guidelines for developers.
- Comprehensive HTTP API documentation structure with main index and specific protocol docs
- Detailed WebDAV API documentation with request/response examples and property specifications
- LibreGraph API documentation covering users, groups, spaces, permissions, and roles
- TUS resumable upload protocol documentation with chunk upload examples
Reviewed Changes
Copilot reviewed 14 out of 18 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/dev/server/Apis/index.md | Main API overview explaining HTTP vs gRPC universes and versioning concepts |
| docs/dev/server/Apis/http/index.md | HTTP protocol introduction and background |
| docs/dev/server/Apis/http/webdav/index.md | Comprehensive WebDAV API documentation with examples and property specifications |
| docs/dev/server/Apis/http/graph/index.md | LibreGraph API overview and calling conventions |
| docs/dev/server/Apis/http/graph/*.md | Individual LibreGraph resource documentation (users, groups, spaces, permissions, roles) |
| docs/dev/server/Apis/http/tus_upload.md | TUS resumable upload protocol documentation |
| docs/dev/server/Apis/http/authorization.md | Authentication and authorization flow documentation |
| docs/dev/server/Apis/grpc_apis/index.md | gRPC overview and CS3 APIs introduction |
| docs/dev/server/Apis/category.json | Category configuration for the APIs section |
| docs/admin/configuration/authentication-and-user-management/keycloak.md | Minor comment correction |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
docs/admin/configuration/authentication-and-user-management/keycloak.md
Outdated
Show resolved
Hide resolved
micbar
force-pushed
the
add-api-docs
branch
2 times, most recently
from
4bd99d1 to
e30c71e
Compare
micbar
force-pushed
the
add-api-docs
branch
from
e30c71e to
0e1993f
Compare
Member
|
Sorry, this was by accident. Wrong button. |
schweigisito
pushed a commit
that referenced
this pull request
Sep 12, 2025
* feat: add Api docs * style: make linter happy * style: fix markdown links * style: apply formatting * fix: link paths and svg * remove Einstein etc. as examples and write Dennis instead --------- Co-authored-by: Anja Barz <a.barz@opencloud.eu>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add